今日及明日的主題是 dbt documentation。

常聽到許多 data 部門，由於多人分工，團隊之間資訊難以流通。
這時候，就會想要找工具、製作文件。
一個可能會遇到的狀況是，做了很多文件，後續卻需要花很多力氣更新，難以維護。

dbt 內建的 documentation，只要一行指令 dbt docs generate 就可以自動產出文件。
自動產的文件包含 dbt 的物件例如 models, macros, seeds, 包含語法、欄位、lineage graph。
我們也可以額外加入 model 及欄位的說明，只要在 config 中加入定義，就會自動包含到產出的文件。

今天會分別說明如何在開發環境/正式環境產出及檢視文件。
明天再深入介紹文件的內容。

dbt docs generate 指令、在開發環境產出及檢視文件

在指令列執行 dbt docs generate ，就可以自動產生文件。

執行完成後，點選 View Docs（書本的圖示），就可以檢視最近一次產出的文件。

在正式環境產出及檢視文件

正式環境的文件則是在上方選單的 Documentation。
現在點進去都還沒東西，是因為我們在正式環境還沒產過文件。

因此，我們要編輯之前在 Day 05 建的 Job: Default Build。
先按 Settings

再按 Edit

在 Execution Settings 將此項打勾 Generate docs on run: Automatically generate updated project docs each time this job runs
按 Save 存檔

回到 Job 按 Run Now

執行完成後，可以看到與之前相比，多了一個步驟 Invoke dbt docs generate。

再來，到 Project Setting，Artifacts -> Documentation，選擇剛剛設定的 Job: Default Build。

都完成了之後，就可以在上方的 Documentation，看到剛剛產出的文件。

今日小結＆明日預告

今天介紹了新的指令 dbt docs generate 並說明了在開發環境以及正式環境如何產出、檢視文件。

明天的主題：深入介紹文件的內容，並說明如何將 model 及欄位的說明加入文件。

參考資料

• Quickstart for dbt Cloud and BigQuery https://docs.getdbt.com/quickstarts/bigquery
• Build and view your docs with dbt Cloud https://docs.getdbt.com/docs/collaborate/build-and-view-your-docs

歡迎加入 dbt community
對 dbt 或 data 有興趣 👋？歡迎加入 dbt community 到 #local-taipei 找我們，也有實體 Meetup 請到 dbt Taipei Meetup 報名參加